home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / C / Frameworks / Grant's CGI Framework 1.0b12 / Documentation / CGI Parameters next >
Text File  |  1995-12-09  |  3KB  |  85 lines
  1. CGI Parameters From the HTTP Server
  2.  
  3. This document is in progress. Please see also the "cgi_params.html" document.
  4.  
  5. path_args
  6.  
  7.   char *      path_args;         /* '----' */
  8.  
  9. The characters in the url following a '$' and before '?' or '#'. This parameter is automatically decoded using the CGIDecodeSpecialChars function.
  10.  
  11. http_search_args
  12.  
  13.   char *      http_search_args;  /* 'kfor' */
  14.  
  15. The characters in the url following a '?' and before '#'. This parameter is automatically decoded using the CGIDecodeSpecialChars function. If the HTTP get method is used, and form support and auto-processing are set on in the compiling options, this parameter will be parsed into the form fields array.
  16.  
  17. username
  18.  
  19.   char *      username;          /* 'user' */
  20.  
  21. The (presumably) authenticated user name. Authentication is done through Realms definitions. See MacHTTP or WebSTAR documentation on Realms.
  22.  
  23. password
  24.  
  25.   char *      password;          /* 'pass' */
  26.  
  27. The authenticated user password. Companion to 'username'.
  28.  
  29. from_user
  30.  
  31.   char *      from_user;         /* 'frmu' */
  32.  
  33. Email address of user (client). Not all client browsers return this information.
  34.  
  35. client_address
  36.  
  37.   char *      client_address;    /* 'addr' */
  38.  
  39. IP address (four integers separated by dots) or domain name of the client.
  40.  
  41. post_args
  42.  
  43.   char *      post_args;         /* 'post' */
  44.  
  45. The characters 'posted' when the HTTP post method is used. This parameter is not automatically decoded. However, if the method is post and form support and auto-processing are set on in the compiling options, this parameter will be parsed into the form fields array.
  46.  
  47. method
  48.  
  49.   HTTPMethod  method;            /* 'meth' */
  50.  
  51. The method used by the client to send it's request/data to the server.
  52. A special typdef'd enumeration has been declared for the HTTP method. It's definition is found the "CGI.h" file.
  53. The method used will normally be "GET", defined as the string constant 'kCGIHTTPMethodGet' and enumerated as 'HTTP_get'.
  54. Form data is usually sent using the "POST" method, which is defined as the string constant 'kCGIHTTPMethodPost' and enumerated as 'HTTP_post'.
  55.  
  56. server_name
  57.  
  58.   char *      server_name;       /* 'svnm' */
  59.   short       server_port;       /* 'svpt' */
  60.   char *      script_name;       /* 'scnm' */
  61.   char *      content_type;      /* 'ctyp' */
  62.   char *      referer;           /* 'refr' */
  63.   char *      user_agent;        /* 'Agnt' */
  64.   char *      action;            /* 'Kact' */
  65.   char *      action_path;       /* 'Kapt' */
  66.   char *      client_ip;         /* 'Kcip' */
  67.   char *      full_request;      /* 'Kfrq' */
  68.   char *      version;           /* 'Pvrs' */
  69.   long        connection;        /* 'Kcid' */
  70.  
  71.   CGIFormField *  formFields;    /* the fields from form submission */
  72.   long        totalFields;       /* total number of fields  */
  73.   
  74.   AppleEvent *  appleEvent;      /* originating appleEvent  */
  75.   AppleEvent *  replyEvent;      /* apple event reply record  */
  76.   
  77.   /* public fields to be filled in */
  78.   char *      responseData;      /* data to return to the client    */
  79.   long        responseSize;      /* size in bytes of the response  */
  80.  
  81.  
  82.  
  83.  
  84.  
  85.